package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.*;
import org.jsola.hr.dto.excel.GysInfoImportDTO;
import org.jsola.hr.query.GysInfoQuery;
import org.jsola.hr.vo.FormGroupVO;
import org.jsola.hr.vo.GysInfoListVO;
import org.jsola.hr.vo.GysInfoVO;
import org.jsola.hr.vo.excel.ParseResultVO;
import org.springframework.core.io.Resource;
import org.springframework.http.ResponseEntity;
import org.springframework.web.multipart.MultipartFile;

import java.util.List;
import java.util.Map;

/**
 * 供应商信息表
 *
 * @author zhr
 */
@Api(tags = "hr-供应商信息表")
public interface IGysInfoControllerAPI {

    /**
     * 新增供应商信息表
     * @param gysInfoAddDTO 供应商信息表新增实体
     * @return 供应商信息表展示对象
     */
    @ApiOperation(value = "新增供应商信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoAddDTO", dataType = "GysInfoAddDTO", value = "新增供应商信息表", paramType = "body")
    })
    Result<GysInfoVO> save(GysInfoAddDTO gysInfoAddDTO);

    /**
     * 新增供应商信息表
     * @param gysAddDTO 字段集合
     * @return 供应商信息表展示对象
     */
    @ApiOperation(value = "新增供应商信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysAddDTO", dataType = "GysAddDTO", value = "新增供应商信息表", paramType = "body")
    })
    Result<GysInfoVO> saveGsyInfo(GysAddDTO gysAddDTO);

    /**
     * 编辑供应商信息表
     * @param gysUpdateDTO 字段集合
     * @return 供应商信息表展示对象
     */
    @ApiOperation(value = "新增供应商信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysUpdateDTO", dataType = "GysUpdateDTO", value = "新增供应商信息表", paramType = "body")
    })
    Result<Integer> updateGsyInfo(GysUpdateDTO gysUpdateDTO);


    /**
     * 修改供应商信息表
     * @param gysInfoUpdateDTO 供应商信息表
     * @return 更新数量
     */
    @ApiOperation(value = "修改供应商信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoUpdateDTO", dataType = "GysInfoUpdateDTO", value = "修改供应商信息表", paramType = "body")
    })
    Result<Integer> update(GysInfoUpdateDTO gysInfoUpdateDTO);

    /**
     * 批量编辑、新增、删除供应商信息表
     * @param gysInfoBatchDTO 要操作的供应商信息表
     * @return 操作之后的全部供应商信息表
     */
    @ApiOperation(value = "批量编辑、新增、删除供应商信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoBatchDTO", dataType = "GysInfoBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(GysInfoBatchDTO gysInfoBatchDTO);



    /**
     * 删除单个供应商信息表，彻底删除
     * @param gysInfoId 供应商信息表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个供应商信息表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoId", dataType = "String", value = "供应商信息表id", paramType = "path")
    })
    Result<Integer> delete(String gysInfoId);


    /**
     * 批量删除供应商信息表，彻底删除
     * @param gysInfoIds 供应商信息表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除供应商信息表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoIds", dataType = "String[]", value = "供应商信息表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] gysInfoIds);


    /**
     * 根据供应商信息表id查询供应商信息表详情
     * @param gysInfoId 供应商信息表id
     * @return 供应商信息表详情
     */
    @ApiOperation(value="根据供应商信息表id查询供应商信息表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoId", dataType = "String", value = "供应商信息表id", paramType = "path")
    })
    Result<GysInfoVO> findById(String gysInfoId);

    @ApiOperation(value="根据供应商信息表id查询供应商信息表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoId", dataType = "String", value = "供应商信息表id", paramType = "path")
    })
    Result<List<FormGroupVO>> findGsyById(String gysInfoId);


    /**
     * 查询供应商信息表
     * @param gysInfoQuery 供应商信息表查询参数
     * @return page
     */
    @ApiOperation(value="查询供应商信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoQuery", dataType = "GysInfoQuery", value = "供应商信息表查询参数", paramType = "query")
    })
    Result<List<GysInfoListVO>> listAll(GysInfoQuery gysInfoQuery);


     /**
     * 分页查询供应商信息表
     * @param gysInfoQuery 供应商信息表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询供应商信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoQuery", dataType = "GysInfoQuery", value = "供应商信息表查询参数", paramType = "query")
    })
    Result<Page<GysInfoListVO>> page(GysInfoQuery gysInfoQuery);

    /**
     * 分页查询供应商信息表.包含自定义字段
     * @param gysInfoQuery 供应商信息表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询供应商信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoQuery", dataType = "GysInfoQuery", value = "供应商信息表查询参数", paramType = "query")
    })
    Result<Page<Map>> selectPageAllField(GysInfoQuery gysInfoQuery);

    /**
     * 供应商信息表导出excel
     * @param gysInfoQuery 供应商信息表查询参数
     * @return excel
     */
    @ApiOperation(value = "供应商信息表导出excel")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gysInfoQuery", dataType = "GysInfoQuery", value = "供应商信息表查询参数", paramType = "query")
    })
    ResponseEntity<Resource> export(GysInfoQuery gysInfoQuery);

    /**
     * 解析excel
     * @param file 上传的文件
     * @param success true返回成功的，false返回失败的，不传返回全部
     * @return 解析结果
     */
    @ApiOperation(value = "解析excel")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "file", value = "文件，Content-Type需要设置为multipart/form-data", paramType = "form"),
            @ApiImplicitParam(name = "success", dataType = "Boolean", value = "true返回成功的，false返回失败的，不传返回全部", paramType = "query")
    })
    Result<List<ParseResultVO<GysInfoImportDTO>>> parseImportFile(MultipartFile file, Boolean success);

     /**
     * 导入excel
     * @param file 上传的文件
     * @param force true忽略错误的行，false有错误中断上传
     * @return 导入成功数量
     */
    @ApiOperation(value = "导入excel")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "file",
                    value = "文件，Content-Type需要设置为multipart/form-data",
                    paramType = "form"),
            @ApiImplicitParam(name = "force", dataType = "Boolean", value = "true忽略错误的行，false有错误中断", paramType = "query")
    })
    Result<Integer> importFile(MultipartFile file, Boolean force);



}

